---
layout: m1x_soap
title: Category Info
---


<h2><a name="catalog_category.info-Module%3AMageCatalog"></a>Module: Mage_Catalog</h2>

<p>The Mage_Catalog module allows you to manage categories and products.</p>

<h4><a name="catalog_category.info-ResourceName%3Acatalogcategory"></a>Resource Name: catalog_category</h4>

<p><b>Aliases:</b></p>
<ul>
	<li>category</li>
</ul>


<h5><a name="catalog_category.info-Method%3A"></a>Method:</h5>

<ul>
	<li>catalog_category.info (SOAP V1)</li>
	<li>catalogCategoryInfo (SOAP V2)</li>
</ul>


<p>Allows you to retrieve information about the required category.</p>

<p><b>Aliases:</b></p>
<ul>
	<li>category.info</li>
</ul>



<p><b>Arguments:</b></p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> sessionId </td>
<td> Session ID </td>
</tr>
<tr>
<td> int </td>
<td> categoryId </td>
<td> Category ID </td>
</tr>
<tr>
<td> string </td>
<td> storeView </td>
<td> Store view ID or code (optional) </td>
</tr>
<tr>
<td> ArrayOfString </td>
<td> attributes </td>
<td> Array of attributes (optional) </td>
</tr>
</tbody></table>


<p><b>Returns</b>:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> array </td>
<td> info </td>
<td> Array of catalogCategoryInfo </td>
</tr>
</tbody></table>


<p>The <b>catalogCategoryInfo</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> category_id <br class="atl-forced-newline" /> </td>
<td> Category ID </td>
</tr>
<tr>
<td> int </td>
<td> is_active <br class="atl-forced-newline" /> </td>
<td> Defines whether the category is active </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> position <br class="atl-forced-newline" /> </td>
<td> Category position </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> level <br class="atl-forced-newline" /> </td>
<td> Category level </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> parent_id <br class="atl-forced-newline" /> </td>
<td> Parent category ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> all_children <br class="atl-forced-newline" /> </td>
<td> All child categories of the current category </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> children <br class="atl-forced-newline" /> </td>
<td> Names of direct child categories </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> created_at <br class="atl-forced-newline" /> </td>
<td> Date when the category was created </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> updated_at <br class="atl-forced-newline" /> </td>
<td> Date when the category was updated </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> name <br class="atl-forced-newline" /> </td>
<td> Category name </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> url_key <br class="atl-forced-newline" /> </td>
<td> A relative URL path which can be entered in place of the standard target path (optional) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> description <br class="atl-forced-newline" /> </td>
<td> Category description </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> meta_title <br class="atl-forced-newline" /> </td>
<td> Category meta title </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> meta_keywords <br class="atl-forced-newline" /> </td>
<td> Category meta keywords </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> meta_description <br class="atl-forced-newline" /> </td>
<td> Category meta description </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> path <br class="atl-forced-newline" /> </td>
<td> Path </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> url_path <br class="atl-forced-newline" /> </td>
<td> URL path </td>
</tr>
<tr>
<td> int </td>
<td> children_count <br class="atl-forced-newline" /> </td>
<td> Number of child categories </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> display_mode <br class="atl-forced-newline" /> </td>
<td> Content that will be displayed on the category view page (optional) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> int </td>
<td> is_anchor <br class="atl-forced-newline" /> </td>
<td> Defines whether the category is anchored </td>
</tr>
<tr>
<td> ArrayOfString </td>
<td> available_sort_by <br class="atl-forced-newline" /> </td>
<td> All available options by which products in the category can be sorted <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> custom_design <br class="atl-forced-newline" /> </td>
<td> The custom design for the category (optional) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> custom_apply_to_products&nbsp; <br class="atl-forced-newline" /> </td>
<td> Apply the custom design to all products assigned to the category (optional) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> custom_design_from <br class="atl-forced-newline" /> </td>
<td> Date starting from which the custom design will be applied to the category (optional) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> custom_design_to <br class="atl-forced-newline" /> </td>
<td> Date till which the custom design will be applied to the category (optional) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> page_layout <br class="atl-forced-newline" /> </td>
<td> Type of page layout that the category should use (optional) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> custom_layout_update <br class="atl-forced-newline" /> </td>
<td> Custom layout update (optional) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> default_sort_by <br class="atl-forced-newline" /> </td>
<td> The default option by which products in the category are sorted <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> int </td>
<td> landing_page <br class="atl-forced-newline" /> </td>
<td> Landing page (optional) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> int </td>
<td> include_in_menu <br class="atl-forced-newline" /> </td>
<td> Defines whether the category is available on the Magento top menu bar <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string </td>
<td> filter_price_range <br class="atl-forced-newline" /> </td>
<td> Price range of each price level displayed in the layered navigation block <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> int </td>
<td> custom_use_parent_settings <br class="atl-forced-newline" /> </td>
<td> Defines whether the category will inherit custom design settings of the category to which it is assigned. 1 - Yes, 0 - No <br class="atl-forced-newline" /> </td>
</tr>
</tbody></table>


<h4><a name="catalog_category.info-Examples"></a>Examples</h4>

<h5><a name="catalog_category.info-RequestExampleSOAPV1"></a>Request Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$client = new SoapClient('http://magentohost/api/soap/?wsdl');

// If somestuff requires api authentification,
// then get a session token
$session = $client-&gt;login('apiUser', 'apiKey');

$result = $client-&gt;call($session, 'catalog_category.info', '5');
var_dump($result);

// If you don't need the session anymore
//$client-&gt;endSession($session);</pre>
		</div>
</div></div>


<h5><a name="catalog_category.info-RequestExampleSOAPV2"></a>Request Example SOAP V2</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
$sessionId = $proxy-&gt;login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary

$result = $proxy-&gt;catalogCategoryInfo($sessionId, '5');
var_dump($result);</pre>
		</div>
</div></div>

<h5><a name="catalog_category.info-RequestExampleSOAPV2%28WSIComplianceMode%29"></a>Request Example SOAP V2 (WS-I Compliance Mode)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');

$sessionId = $proxy-&gt;login((object)array('username' =&gt; 'apiUser', 'apiKey' =&gt; 'apiKey'));

$result = $proxy-&gt;catalogCategoryInfo((object)array('sessionId' =&gt; $sessionId-&gt;result, 'categoryId' =&gt; '5'));
var_dump($result-&gt;result);</pre>
		</div>
</div></div>

<h5><a name="catalog_category.info-ResponseExampleSOAPV1"></a>Response Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: java; gutter: false">array
  'category_id' =&gt; string '5' (length=1)
  'is_active' =&gt; string '1' (length=1)
  'position' =&gt; string '1' (length=1)
  'level' =&gt; string '2' (length=1)
  'parent_id' =&gt; int 3
  'increment_id' =&gt; null
  'created_at' =&gt; string '2012-03-29 12:30:51' (length=19)
  'updated_at' =&gt; string '2012-03-29 14:25:08' (length=19)
  'name' =&gt; string 'Mobile Phones' (length=13)
  'url_key' =&gt; string 'mobile-phones' (length=13)
  'thumbnail' =&gt; null
  'description' =&gt; string 'Category for cell phones' (length=24)
  'image' =&gt; null
  'meta_title' =&gt; string 'Cell Phones' (length=11)
  'meta_keywords' =&gt; string 'cell, phone' (length=11)
  'meta_description' =&gt; null
  'include_in_menu' =&gt; string '1' (length=1)
  'path' =&gt; string '1/3/4' (length=5)
  'all_children' =&gt; string '4' (length=1)
  'path_in_store' =&gt; null
  'children' =&gt; string '' (length=0)
  'url_path' =&gt; string 'mobile-phones.html' (length=18)
  'children_count' =&gt; string '0' (length=1)
  'display_mode' =&gt; string 'PRODUCTS' (length=8)
  'landing_page' =&gt; null
  'is_anchor' =&gt; string '1' (length=1)
  'available_sort_by' =&gt; null
  'default_sort_by' =&gt; null
  'filter_price_range' =&gt; null
  'custom_use_parent_settings' =&gt; string '1' (length=1)
  'custom_apply_to_products' =&gt; null
  'custom_design' =&gt; null
  'custom_design_from' =&gt; null
  'custom_design_to' =&gt; null
  'page_layout' =&gt; null
  'custom_layout_update' =&gt; null</pre>
		</div>
</div></div>

<?php include(__ROOT__ . 'footer.php'); ?>
